package com.sjh.rlock;

import org.redisson.api.RLock;

import java.util.concurrent.TimeUnit;

/**
 * redisson操作锁的API接口
 * @author jack
 * @data 2020/8/17 2:15 下午
 */
public interface DistributedRLock {
    /**
     * 获取锁，并且加锁
     * 拿不到lock就不罢休，不然线程就一直block
     * @param lockKey 锁名
     * @return
     */
    RLock lock(String lockKey);

    /**
     * 获取锁，并且加锁
     * 拿不到lock就不罢休，不然线程就一直block
     * @param lockKey 锁名
     * @param timeout 超时时间-> 单位 SECONDS
     * @return
     */
    RLock lock(String lockKey, long timeout);

    /**
     * 获取锁，并且加锁
     *  拿不到lock就不罢休，不然线程就一直block
     * @param lockKey 锁名
     * @param unit  时间单位
     * @param timeout 超时时间
     * @return
     */
    RLock lock(String lockKey, TimeUnit unit, long timeout);

    /**
     * 在 waitTime 时间内 尝试获取锁，并加锁，超过waitTime 将结束等待 返回false
     * @param lockKey 锁名
     * @param unit 时间单位
     * @param waitTime 等待时间
     * @param leaseTime 锁过期时间，如果超过leaseTime还没有解锁的话, 我就强制解锁
     * @return
     */
    boolean tryLock(String lockKey, TimeUnit unit, long waitTime, long leaseTime);


    /**
     * 在 waitTime（默认5秒） 时间内 尝试获取锁，并加锁，超过waitTime(10秒) 将结束等待 返回false
     * @param lockKey
     * @return
     */
    boolean tryLock(String lockKey);

    /**
     * 解锁
     * @param lockKey
     */
    void unlock(String lockKey);

    /**
     * 解锁
     * @param lock
     */
    void unlock(RLock lock);
}
